MessagingStyle

Helper class for generating large-format notifications that include multiple back-and-forth messages of varying types between any number of people. In order to get a backwards compatible behavior, the app needs to use the v7 version of the notification builder together with this style, otherwise the user will see the normal notification view. Use setConversationTitle to set a conversation title for group chats with more than two people. This could be the user-created name of the group or, if it doesn't have a specific name, a list of the participants in the conversation. Do not set a conversation title for one-on-one chats, since platforms use the existence of this field as a hint that the conversation is a group. This class is a "rebuilder": It attaches to a Builder object and modifies its behavior, like so:


Notification notification = new Notification.Builder()
    .setContentTitle("2 new messages with " + sender.toString())
    .setContentText(subject)
    .setSmallIcon(R.drawable.new_message)
    .setLargeIcon(aBitmap)
    .setStyle(new Notification.MessagingStyle(resources.getString(R.string.reply_name))
        .addMessage(messages[0].getText(), messages[0].getTime(), messages[0].getSender())
        .addMessage(messages[1].getText(), messages[1].getTime(), messages[1].getSender()))
    .build();

Constructors

Link copied to clipboard
constructor(@NonNull userDisplayName: CharSequence)
constructor(@NonNull user: Person)
Creates a new MessagingStyle object.

Types

Link copied to clipboard
class Message

Properties

Link copied to clipboard
The maximum number of messages that will be retained in the Notification itself (the number displayed is up to the platform).

Functions

Link copied to clipboard
open fun addCompatExtras(@NonNull extras: Bundle)
This is called with the extras of the framework Notification during the build process, after apply() has been called.
Link copied to clipboard
Adds a Message for historic context in this notification.
Link copied to clipboard
Adds a Message for display in this notification.
Adds a message for display by this notification.
Link copied to clipboard
Link copied to clipboard
Retrieves a MessagingStyle from a Notification, enabling an application that has set a MessagingStyle using NotificationCompat or Notification.Builder to send messaging information to another application using NotificationCompat, regardless of the API level of the system.
Link copied to clipboard
Return the title to be displayed on this conversation.
Link copied to clipboard
Gets the list of historic Messages in the notification.
Link copied to clipboard
Gets the list of Message objects that represent the notification.
Link copied to clipboard
open fun getUser(): Person
Returns the person to be used for any replies sent by the user.
Link copied to clipboard
Returns the name to be displayed for any replies sent by the user.
Link copied to clipboard
Returns true if this notification represents a group conversation, otherwise false.
Link copied to clipboard
Sets the title to be displayed on this conversation.
Link copied to clipboard
Sets whether this conversation notification represents a group.